package com.guigu.gulicommon.api;

/**
 * 分页查询参数API
 *
 * @author 陈俊杰
 * @version 1.0
 * @since 2024/8/17 22:31
 */
public interface PageQueryParameters {
    Long getPageNum();

    Long getPageSize();

    String getQueryParam();
    /**
     * 设置页码数
     * <p>
     * 本函数的目的是为了确保页码数在一个合理的范围内如果页码数小于1，将其设置为1；
     * 如果页码数超过了最大值，将其设置为最大值这样可以确保页码数的合法性，避免出现错误的页码数导致的问题
     *
     * @param pageNum 传入的页码数，可能为null或一个具体的数值
     */
    void setPageNum(Long pageNum);

    /**
     * 设置分页大小
     *
     * @param pageSize 指定的页面大小
     */
    void setPageSize(Long pageSize);


}
